// Copyright (c) 2021 Terminus, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package apistructs

type HealthStatus string

const (
	HealthStatusOk      HealthStatus = "ok"
	HealthStatusWarning HealthStatus = "warning"
	HealthStatusFail    HealthStatus = "fail"
)

// HealthResponse the response struct of health check
type HealthResponse struct {
	Name    string            `json:"name"`
	Status  HealthStatus      `json:"status"`
	Modules []Module          `json:"modules"`
	Tags    map[string]string `json:"tags"`
}

type Module struct {
	Name    string       `json:"name"`
	Status  HealthStatus `json:"status"`
	Message string       `json:"message"`
}
